Skip to content

Conversation

@KingaMas
Copy link
Member

@KingaMas KingaMas commented Nov 11, 2025

Pull Request Template

Description

Running the tutorial in Colab sparked calls for dependencies. Added dependency installation on the top cell.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • [ x ] Bug fix (non-breaking change which fixes an issue)

Summary by CodeRabbit

  • Documentation
    • Updated the crystal space visualisation tutorial to optimise Colab setup for interactive plotting and reliable rendering in notebooks.
    • Added installation steps in the Colab section to ensure required plotting and headless-rendering support so interactive figures display correctly and static exports render consistently.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 11, 2025

Walkthrough

A Jupyter notebook tutorial's Colab setup block was updated to install additional plotting and rendering dependencies: plotly>=6.1.1, kaleido, and plotly-get-chrome when running in Google Colab.

Changes

Cohort / File(s) Change Summary
Colab installation dependencies
docs/tutorials/crystal_space_visualisation.ipynb
Appended additional shell commands in the Colab installation block to install plotly>=6.1.1 and kaleido, and to run plotly-get-chrome -y for headless browser support.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Check that plotly>=6.1.1, kaleido and plotly-get-chrome install cleanly in the Colab environment.
  • Verify the notebook cells that rely on these packages run correctly in Colab after installation.

Poem

🐰 I hopped into Colab, scripts in paw,

Installed plotly and kaleido—oh what a draw!
Chrome for the plots, headless and spry,
Visuals now sparkle beneath the sky,
A tiny rabbit cheers, charts dancing high.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description is substantially incomplete. It covers only the Description and Type of change sections, whilst missing most required sections including testing details, reviewer mentions, and the full checklist. Complete the pull request description by adding 'How Has This Been Tested?' section with test details and configuration, mention relevant reviewers, and complete the full checklist with appropriate selections.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarises the main change: adding dependencies for running the tutorial in Colab, which aligns with the actual modifications to the notebook.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch bugfix/crystal_space_visualisation_dependencies

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 70a27a0 and 8d87e59.

📒 Files selected for processing (1)
  • docs/tutorials/crystal_space_visualisation.ipynb (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/tutorials/crystal_space_visualisation.ipynb
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
  • GitHub Check: test (3.13, ubuntu-latest)
  • GitHub Check: test (3.12, macos-latest)
  • GitHub Check: test (3.13, macos-latest)
  • GitHub Check: test (3.12, ubuntu-latest)
  • GitHub Check: test (3.12, windows-latest)
  • GitHub Check: test (3.11, ubuntu-latest)
  • GitHub Check: test (3.11, windows-latest)
  • GitHub Check: test (3.10, windows-latest)
  • GitHub Check: test (3.10, ubuntu-latest)
  • GitHub Check: test (3.11, macos-latest)
  • GitHub Check: test (3.10, macos-latest)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link

codecov bot commented Nov 11, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.66%. Comparing base (ddd8af8) to head (8d87e59).
⚠️ Report is 5 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #464      +/-   ##
===========================================
+ Coverage    80.63%   80.66%   +0.03%     
===========================================
  Files           33       33              
  Lines         2871     2871              
===========================================
+ Hits          2315     2316       +1     
+ Misses         556      555       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5865dcd and 70a27a0.

📒 Files selected for processing (1)
  • docs/tutorials/crystal_space_visualisation.ipynb (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
  • GitHub Check: test (3.13, ubuntu-latest)
  • GitHub Check: test (3.13, macos-latest)
  • GitHub Check: test (3.12, windows-latest)
  • GitHub Check: test (3.12, ubuntu-latest)
  • GitHub Check: test (3.11, windows-latest)
  • GitHub Check: test (3.11, macos-latest)
  • GitHub Check: test (3.12, macos-latest)
  • GitHub Check: test (3.10, ubuntu-latest)
  • GitHub Check: test (3.11, ubuntu-latest)
  • GitHub Check: test (3.10, windows-latest)
  • GitHub Check: test (3.10, macos-latest)

@KingaMas KingaMas merged commit 6b73d31 into develop Nov 11, 2025
17 checks passed
@KingaMas KingaMas deleted the bugfix/crystal_space_visualisation_dependencies branch November 11, 2025 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants